Documentation update #1573
Merged
Documentation update #1573
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
LaszloLango
added
documentation
bzsolt
requested changes
Feb 9, 2017
docs/01.GETTING-STARTED.md
Outdated
| **Change default heap size (512K)** | ||
|
|
||
| ```bash | ||
| python tools/build.py --mem-heap=256K |
There was a problem hiding this comment.
Just --mem-heap=256, this option accepts integers.
docs/01.GETTING-STARTED.md
Outdated
| If you would like to use more than 512K, then you must enable the 32 bit compressed pointers. | ||
|
|
||
| ```bash | ||
| python tools/build.py --cpointer-32bit=on --mem-heap=1024K |
| **Use system memory allocator** | ||
|
|
||
| ```bash | ||
| python tools/build.py --system-allocator=on --jerry-libc=off |
There was a problem hiding this comment.
I think it would be good to add --compile-flag=-m32 to the command or add some hints about how to build to 32bit.
There was a problem hiding this comment.
@bzsolt, this is why I wrote a note. :)
dbatyai
reviewed
Feb 9, 2017
docs/01.GETTING-STARTED.md
Outdated
| python tools/build.py --cpointer-32bit=on --mem-heap=1024K | ||
| ``` | ||
|
|
||
| *Note*: Memory allocator of JerryScript will allocate the full heap, when the engine starts. |
There was a problem hiding this comment.
This isn't completely correct, as our memory allocator has no responsibility to allocate the heap. The heap will be allocated statically at compile time.
docs/02.API-REFERENCE.md
Outdated
| if the value parameter is not a string or the buffer is | ||
| not large enough for the whole string. | ||
| Copy the characters of a string into a specified cesu-8 buffer. | ||
| The '\0' character could occur in character buffer. Returns 0, |
JerryScript-DCO-1.0-Signed-off-by: László Langó [email protected]
LaszloLango
force-pushed
the
update-documentation
branch
from
e702ccb to
d1cbb8a
Compare
bzsolt
approved these changes
Feb 10, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
JerryScript-DCO-1.0-Signed-off-by: László Langó [email protected]